<meta charset="utf-8">
(#) Usage of insecure sticky broadcasts

!!! WARNING: Usage of insecure sticky broadcasts
   This is a warning.

Id
:   `InsecureStickyBroadcastsPermission`
Summary
:   Usage of insecure sticky broadcasts
Severity
:   Warning
Category
:   Security
Platform
:   Android
Vendor
:   Google - Android 3P Vulnerability Research
Contact
:   https://github.com/google/android-security-lints
Feedback
:   https://github.com/google/android-security-lints/issues
Min
:   Lint 4.1
Compiled
:   Lint 8.0 and 8.1
Artifact
:   [com.android.security.lint:lint](com_android_security_lint_lint.md.html)
Since
:   1.0.2
Affects
:   Manifest files
Editing
:   This check runs on the fly in the IDE editor
See
:   https://goo.gle/InsecureStickyBroadcastsPermission
Implementation
:   [Source Code](https://github.com/google/android-security-lints/tree/main/checks/src/main/java/com/example/lint/checks/StickyBroadcastsDetector.kt)
Tests
:   [Source Code](https://github.com/google/android-security-lints/tree/main/checks/src/test/java/com/example/lint/checks/StickyBroadcastsDetectorTest.kt)
Copyright Year
:   2024

Sticky broadcasts can be accessed, sent, or modified by anyone,
resulting in potential security issues. For this reason, it was
deprecated in API level 21 and other mechanisms such as databases or
non-sticky broadcasts should be used instead.

(##) Example

Here is an example of lint warnings produced by this check:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~text
AndroidManifest.xml:2:Warning: Sticky broadcasts can be accessed, sent
or modified by anyone. Use non-sticky broadcasts instead.
[InsecureStickyBroadcastsPermission]
    &lt;uses-permission android:name="android.permission.BROADCAST_STICKY"/&gt;
    ---------------------------------------------------------------------
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Here is the source file referenced above:

`AndroidManifest.xml`:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~xml linenumbers
&lt;manifest xmlns:android='http://schemas.android.com/apk/res/android' package='test.pkg'&gt;
                    &lt;uses-permission android:name="android.permission.BROADCAST_STICKY"/&gt;
                    &lt;application&gt;
                        &lt;activity android:name='com.example.MainActivity'&gt;&lt;/activity&gt;
                    &lt;/application&gt;
                    &lt;/manifest&gt;
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

You can also visit the
[source code](https://github.com/google/android-security-lints/tree/main/checks/src/test/java/com/example/lint/checks/StickyBroadcastsDetectorTest.kt)
for the unit tests for this check to see additional scenarios.

The above example was automatically extracted from the first unit test
found for this lint check, `StickyBroadcastsDetector.stickyBroadcastPermissionInManifest_showsWarning`.
To report a problem with this extracted sample, visit
https://github.com/google/android-security-lints/issues.

(##) Including

!!!
   This is not a built-in check. To include it, add the below dependency
   to your project. This lint check is included in the lint documentation,
   but the Android team may or may not agree with its recommendations.

```
// build.gradle.kts
lintChecks("com.android.security.lint:lint:1.0.3")

// build.gradle
lintChecks 'com.android.security.lint:lint:1.0.3'

// build.gradle.kts with version catalogs:
lintChecks(libs.com.android.security.lint.lint)

# libs.versions.toml
[versions]
com-android-security-lint-lint = "1.0.3"
[libraries]
# For clarity and text wrapping purposes the following declaration is
# shown split up across lines, but in TOML it needs to be on a single
# line (see https://github.com/toml-lang/toml/issues/516) so adjust
# when pasting into libs.versions.toml:
com-android-security-lint-lint = {
    module = "com.android.security.lint:lint",
    version.ref = "com-android-security-lint-lint"
}
```

1.0.3 is the version this documentation was generated from;
there may be newer versions available.

[Additional details about com.android.security.lint:lint](com_android_security_lint_lint.md.html).
(##) Suppressing

You can suppress false positives using one of the following mechanisms:

* Adding the suppression attribute
  `tools:ignore="InsecureStickyBroadcastsPermission"` on the
  problematic XML element (or one of its enclosing elements). You may
  also need to add the following namespace declaration on the root
  element in the XML file if it's not already there:
  `xmlns:tools="http://schemas.android.com/tools"`.

  ```xml
  &lt;?xml version="1.0" encoding="UTF-8"?&gt;
  &lt;manifest xmlns:tools="http://schemas.android.com/tools"&gt;
      ...
      &lt;uses-permission tools:ignore="InsecureStickyBroadcastsPermission" .../&gt;
    ...
  &lt;/manifest&gt;
  ```

* Using a special `lint.xml` file in the source tree which turns off
  the check in that folder and any sub folder. A simple file might look
  like this:
  ```xml
  &lt;?xml version="1.0" encoding="UTF-8"?&gt;
  &lt;lint&gt;
      &lt;issue id="InsecureStickyBroadcastsPermission" severity="ignore" /&gt;
  &lt;/lint&gt;
  ```
  Instead of `ignore` you can also change the severity here, for
  example from `error` to `warning`. You can find additional
  documentation on how to filter issues by path, regular expression and
  so on
  [here](https://googlesamples.github.io/android-custom-lint-rules/usage/lintxml.md.html).

* In Gradle projects, using the DSL syntax to configure lint. For
  example, you can use something like
  ```gradle
  lintOptions {
      disable 'InsecureStickyBroadcastsPermission'
  }
  ```
  In Android projects this should be nested inside an `android { }`
  block.

* For manual invocations of `lint`, using the `--ignore` flag:
  ```
  $ lint --ignore InsecureStickyBroadcastsPermission ...`
  ```

* Last, but not least, using baselines, as discussed
  [here](https://googlesamples.github.io/android-custom-lint-rules/usage/baselines.md.html).

<!-- Markdeep: --><style class="fallback">body{visibility:hidden;white-space:pre;font-family:monospace}</style><script src="markdeep.min.js" charset="utf-8"></script><script src="https://morgan3d.github.io/markdeep/latest/markdeep.min.js" charset="utf-8"></script><script>window.alreadyProcessedMarkdeep||(document.body.style.visibility="visible")</script>